﻿/**
 * 
 * Copyright 2009 Mike Jamer [email: mikejamer@gmail.com ]
 * 
 * This File is part of Moose IRC
 * 
 * MooseIRC is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * MooseIRC is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with MooseIRC.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */

using mooseirc.utility;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;

namespace mooseirc.irc {

    /// <summary>
    /// Represenets an IrcResponse,
    /// this is a base class, that will generally be dirrived from
    /// </summary>
    [CLSCompliant(true)]
    public abstract class IrcResponse : Object, IDisposable {

        /// <summary>
        /// Initialize IRCResponse
        /// </summary>
        public IrcResponse()
        {
            return;
        }

        /// <summary>
        /// Responses must specify valid IrcStates
        /// </summary>
        /// <returns>Valid IRC States</returns>
        protected abstract IrcState validStates();

        /// <summary>
        /// Trigger Action
        /// </summary>
        protected abstract void action(IrcConnection connection, IrcState state, string[] response, Stream outputStream);

        /// <summary>
        /// Execute Trigger
        /// </summary>
        public void execute(IrcConnection connection, IrcState state, string[] response, Stream outputStream)
        {
            if (validStates().validIrcState(state))
            {
                action(connection, state, response, outputStream);
            }
            return;
        }

        #region [IDispose Implementation]

        /// <summary>
        /// Dispose IrcResponse
        /// </summary>
        public void Dispose()
        {
            return;
        }

        #endregion

    }
}
